<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Duplex</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Fields">Fields</a></li>
</ul>


<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../modules/Duplex.Application.html">Duplex.Application</a></li>
  <li><a href="../modules/Duplex.Applications.Effect.html">Duplex.Applications.Effect</a></li>
  <li><a href="../modules/Duplex.Applications.GridPie.html">Duplex.Applications.GridPie</a></li>
  <li><a href="../modules/Duplex.Applications.Hydra.html">Duplex.Applications.Hydra</a></li>
  <li><a href="../modules/Duplex.Applications.Instrument.html">Duplex.Applications.Instrument</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.GridLayout.html">Duplex.Applications.Keyboard.GridLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.HarmonicLayout.html">Duplex.Applications.Keyboard.Layouts.HarmonicLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.IsomorphicLayout.html">Duplex.Applications.Keyboard.Layouts.IsomorphicLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.Layouts.PianoLayout.html">Duplex.Applications.Keyboard.Layouts.PianoLayout</a></li>
  <li><a href="../modules/Duplex.Applications.Keyboard.html">Duplex.Applications.Keyboard</a></li>
  <li><a href="../modules/Duplex.Applications.Matrix.html">Duplex.Applications.Matrix</a></li>
  <li><a href="../modules/Duplex.Applications.Metronome.html">Duplex.Applications.Metronome</a></li>
  <li><a href="../modules/Duplex.Applications.MidiActions.Bindings.html">Duplex.Applications.MidiActions.Bindings</a></li>
  <li><a href="../modules/Duplex.Applications.MidiActions.html">Duplex.Applications.MidiActions</a></li>
  <li><a href="../modules/Duplex.Applications.Mixer.html">Duplex.Applications.Mixer</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_group.html">Duplex.Applications.Mlrx.Mlrx_group</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_note.html">Duplex.Applications.Mlrx.Mlrx_note</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_pos.html">Duplex.Applications.Mlrx.Mlrx_pos</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.Mlrx_track.html">Duplex.Applications.Mlrx.Mlrx_track</a></li>
  <li><a href="../modules/Duplex.Applications.Mlrx.html">Duplex.Applications.Mlrx</a></li>
  <li><a href="../modules/Duplex.Applications.Navigator.html">Duplex.Applications.Navigator</a></li>
  <li><a href="../modules/Duplex.Applications.NotesOnWheels.html">Duplex.Applications.NotesOnWheels</a></li>
  <li><a href="../modules/Duplex.Applications.PatternCursor.html">Duplex.Applications.PatternCursor</a></li>
  <li><a href="../modules/Duplex.Applications.PatternSequence.html">Duplex.Applications.PatternSequence</a></li>
  <li><a href="../modules/Duplex.Applications.Recorder.html">Duplex.Applications.Recorder</a></li>
  <li><a href="../modules/Duplex.Applications.Repeater.html">Duplex.Applications.Repeater</a></li>
  <li><a href="../modules/Duplex.Applications.Rotate.html">Duplex.Applications.Rotate</a></li>
  <li><a href="../modules/Duplex.Applications.StepSequencer.html">Duplex.Applications.StepSequencer</a></li>
  <li><a href="../modules/Duplex.Applications.SwitchConfiguration.html">Duplex.Applications.SwitchConfiguration</a></li>
  <li><a href="../modules/Duplex.Applications.TestPad.html">Duplex.Applications.TestPad</a></li>
  <li><a href="../modules/Duplex.Applications.TrackSelector.html">Duplex.Applications.TrackSelector</a></li>
  <li><a href="../modules/Duplex.Applications.Transport.html">Duplex.Applications.Transport</a></li>
  <li><a href="../modules/Duplex.Applications.UIButtonTest.html">Duplex.Applications.UIButtonTest</a></li>
  <li><a href="../modules/Duplex.Applications.XYPad.html">Duplex.Applications.XYPad</a></li>
  <li><a href="../modules/Duplex.Automation.html">Duplex.Automation</a></li>
  <li><a href="../modules/Duplex.Browser.html">Duplex.Browser</a></li>
  <li><a href="../modules/Duplex.BrowserProcess.html">Duplex.BrowserProcess</a></li>
  <li><a href="../modules/Duplex.Canvas.html">Duplex.Canvas</a></li>
  <li><a href="../modules/Duplex.CanvasPoint.html">Duplex.CanvasPoint</a></li>
  <li><a href="../modules/Duplex.ControlMap.html">Duplex.ControlMap</a></li>
  <li><a href="../modules/Duplex.Device.html">Duplex.Device</a></li>
  <li><a href="../modules/Duplex.Display.html">Duplex.Display</a></li>
  <li><a href="../modules/Duplex.Globals.html">Duplex.Globals</a></li>
  <li><strong>Duplex.Message</strong></li>
  <li><a href="../modules/Duplex.MessageStream.html">Duplex.MessageStream</a></li>
  <li><a href="../modules/Duplex.MidiDevice.html">Duplex.MidiDevice</a></li>
  <li><a href="../modules/Duplex.OscClient.html">Duplex.OscClient</a></li>
  <li><a href="../modules/Duplex.OscDevice.html">Duplex.OscDevice</a></li>
  <li><a href="../modules/Duplex.OscVoiceMgr.html">Duplex.OscVoiceMgr</a></li>
  <li><a href="../modules/Duplex.Preferences.html">Duplex.Preferences</a></li>
  <li><a href="../modules/Duplex.ProcessSlicer.html">Duplex.ProcessSlicer</a></li>
  <li><a href="../modules/Duplex.RoamingDSP.html">Duplex.RoamingDSP</a></li>
  <li><a href="../modules/Duplex.Scheduler.html">Duplex.Scheduler</a></li>
  <li><a href="../modules/Duplex.StateController.html">Duplex.StateController</a></li>
  <li><a href="../modules/Duplex.UIButton.html">Duplex.UIButton</a></li>
  <li><a href="../modules/Duplex.UIButtonStrip.html">Duplex.UIButtonStrip</a></li>
  <li><a href="../modules/Duplex.UIComponent.html">Duplex.UIComponent</a></li>
  <li><a href="../modules/Duplex.UIKey.html">Duplex.UIKey</a></li>
  <li><a href="../modules/Duplex.UIKeyPressure.html">Duplex.UIKeyPressure</a></li>
  <li><a href="../modules/Duplex.UILabel.html">Duplex.UILabel</a></li>
  <li><a href="../modules/Duplex.UIPad.html">Duplex.UIPad</a></li>
  <li><a href="../modules/Duplex.UIPitchBend.html">Duplex.UIPitchBend</a></li>
  <li><a href="../modules/Duplex.UISlider.html">Duplex.UISlider</a></li>
  <li><a href="../modules/Duplex.UISpinner.html">Duplex.UISpinner</a></li>
  <li><a href="../modules/Duplex.WidgetHooks.html">Duplex.WidgetHooks</a></li>
  <li><a href="../modules/Duplex.WidgetKeyboard.html">Duplex.WidgetKeyboard</a></li>
  <li><a href="../modules/Duplex.html">Duplex</a></li>
  <li><a href="../modules/main.html">main</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>Duplex.Message</code></h1>
<p>Initialize Message class</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#__eq">__eq (other)</a></td>
	<td class="summary">Compare with another instance (only check for object identity)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#__tostring">__tostring ()</a></td>
	<td class="summary">Return message (for debugging purposes)</td>
	</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#self.context">self.context</a></td>
	<td class="summary">(<a href="../modules/Duplex.Globals.html#DEVICE_MESSAGE">Duplex.Globals.DEVICE_MESSAGE</a>) the message context</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.xarg">self.xarg</a></td>
	<td class="summary">(table) <code>Param</code> node attributes, derived from the control-map</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.device">self.device</a></td>
	<td class="summary">(<a href="../modules/Duplex.Device.html#">Duplex.Device</a>) reference to the originating device</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.value">self.value</a></td>
	<td class="summary">(table, number or string) the value for the chosen parameter
 the type of value depend on what type of parameter we are controlling:
 a slider would have a number, a label a string, xypad a pair of numbers</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.channel">self.channel</a></td>
	<td class="summary">(int) the MIDI channel of the message, between 1-16
 (derived from the value parameter in the control-map)</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.is_note_off">self.is_note_off</a></td>
	<td class="summary">(bool) distinguish between MIDI NOTE-ON/OFF events</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.is_virtual">self.is_virtual</a></td>
	<td class="summary">(bool) true when triggered from the virtual control surface</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.midi_msgs">self.midi_msgs</a></td>
	<td class="summary">(table) the MIDI message payload (each entry a table of 3 bytes)
 this is either a copy of the message(s) we received from a MIDI controller,
 or a value being constructed by the virtual control surface</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#self.timestamp">self.timestamp</a></td>
	<td class="summary">(number) set by os.clock()</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>
    <dl class="function">
    <dt>
    <a name = "__eq"></a>
    <strong>__eq (other)</strong>
    </dt>
    <dd>
    Compare with another instance (only check for object identity)


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">other</span>
         (<a href="../modules/Duplex.Message.html#">Duplex.Message</a>)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        bool
    </ol>




</dd>
    <dt>
    <a name = "__tostring"></a>
    <strong>__tostring ()</strong>
    </dt>
    <dd>
    Return message (for debugging purposes)







</dd>
</dl>
    <h2><a name="Fields"></a>Fields</h2>
    <dl class="function">
    <dt>
    <a name = "self.context"></a>
    <strong>self.context</strong>
    </dt>
    <dd>
    (<a href="../modules/Duplex.Globals.html#DEVICE_MESSAGE">Duplex.Globals.DEVICE_MESSAGE</a>) the message context







</dd>
    <dt>
    <a name = "self.xarg"></a>
    <strong>self.xarg</strong>
    </dt>
    <dd>
    (table) <code>Param</code> node attributes, derived from the control-map





    <h3>See also:</h3>
    <ul>
         <a href="../modules/Duplex.ControlMap.html#">Duplex.ControlMap</a>
    </ul>


</dd>
    <dt>
    <a name = "self.device"></a>
    <strong>self.device</strong>
    </dt>
    <dd>
    (<a href="../modules/Duplex.Device.html#">Duplex.Device</a>) reference to the originating device







</dd>
    <dt>
    <a name = "self.value"></a>
    <strong>self.value</strong>
    </dt>
    <dd>
    (table, number or string) the value for the chosen parameter
 the type of value depend on what type of parameter we are controlling:
 a slider would have a number, a label a string, xypad a pair of numbers







</dd>
    <dt>
    <a name = "self.channel"></a>
    <strong>self.channel</strong>
    </dt>
    <dd>
    (int) the MIDI channel of the message, between 1-16
 (derived from the value parameter in the control-map)







</dd>
    <dt>
    <a name = "self.is_note_off"></a>
    <strong>self.is_note_off</strong>
    </dt>
    <dd>
    (bool) distinguish between MIDI NOTE-ON/OFF events







</dd>
    <dt>
    <a name = "self.is_virtual"></a>
    <strong>self.is_virtual</strong>
    </dt>
    <dd>
    (bool) true when triggered from the virtual control surface







</dd>
    <dt>
    <a name = "self.midi_msgs"></a>
    <strong>self.midi_msgs</strong>
    </dt>
    <dd>
    (table) the MIDI message payload (each entry a table of 3 bytes)
 this is either a copy of the message(s) we received from a MIDI controller,
 or a value being constructed by the virtual control surface







</dd>
    <dt>
    <a name = "self.timestamp"></a>
    <strong>self.timestamp</strong>
    </dt>
    <dd>
    (number) set by os.clock()







</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
